/*!	 importer.h
**	 It is the base class for all the importers.
**
**	Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
**
**	This package is free software; you can redistribute it and/or
**	modify it under the terms of the GNU General Public License as
**	published by the Free Software Foundation; either version 2 of
**	the License, or (at your option) any later version.
**
**	This package is distributed in the hope that it will be useful,
**	but WITHOUT ANY WARRANTY; without even the implied warranty of
**	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
**	General Public License for more details.
**
*/

#ifndef __SYNFIG_IMPORTER_H
#define __SYNFIG_IMPORTER_H

#include <cstdio>

#include <map>

#include <ETL/handle>

#include "filesystem.h"
#include "gamma.h"
#include "progresscallback.h"
#include "renddesc.h"
#include "string.h"
#include "time.h"

#include <synfig/rendering/surface.h>

// Defines various variables and the create method, common for all importers.
// To be used in the private part of the importer class definition.
#define SYNFIG_IMPORTER_MODULE_EXT \
		public: static const char name__[], version__[], ext__[],cvs_id__[]; \
		static const bool supports_file_system_wrapper__; \
		static synfig::Importer *create(const synfig::FileSystem::Identifier &identifier);

// Defines constructor for class derived from other class which derived from Importer
#define SYNFIG_IMPORTER_MODULE_CONSTRUCTOR_DERIVED(class, parent) \
		public: class(const synfig::FileSystem::Identifier &identifier): parent(identifier) { }

// Defines constructor for class derived from Importer
#define SYNFIG_IMPORTER_MODULE_CONSTRUCTOR(class) \
		SYNFIG_IMPORTER_MODULE_CONSTRUCTOR_DERIVED(class, synfig::Importer)

// Defines various variables and the create method, common for all importers.
// To be used in the private part of the importer class definition.
// And defines constructor for class derived from other class which derived from Importer
#define SYNFIG_IMPORTER_MODULE_DECLARATIONS_DERIVED(class, parent) \
		SYNFIG_IMPORTER_MODULE_EXT \
		SYNFIG_IMPORTER_MODULE_CONSTRUCTOR_DERIVED(class, parent)

// Defines various variables and the create method, common for all importers.
// To be used in the private part of the importer class definition.
// And defines constructor
#define SYNFIG_IMPORTER_MODULE_DECLARATIONS(class) \
		SYNFIG_IMPORTER_MODULE_EXT \
		SYNFIG_IMPORTER_MODULE_CONSTRUCTOR(class)

// Sets the name of the importer.
#define SYNFIG_IMPORTER_SET_NAME(class,x) const char class::name__[]=x

// Sets the primary file extension of the importer.
#define SYNFIG_IMPORTER_SET_EXT(class,x) const char class::ext__[]=x

// Sets the version of the importer.
#define SYNFIG_IMPORTER_SET_VERSION(class,x) const char class::version__[]=x

// Sets the CVS ID of the importer.
#define SYNFIG_IMPORTER_SET_CVS_ID(class,x) const char class::cvs_id__[]=x

// Sets the supports_file_system_wrapper flag of the importer.
#define SYNFIG_IMPORTER_SET_SUPPORTS_FILE_SYSTEM_WRAPPER(class,x) const bool class::supports_file_system_wrapper__=x

// Defines de implementation of the create method for the importer
// \param identifier The identifier of file to be imported by the importer.
#define SYNFIG_IMPORTER_INIT(class) synfig::Importer* class::create(const synfig::FileSystem::Identifier &identifier) { return new class(identifier); }

namespace synfig
{

class Surface;

/*!	\class Importer
**	 Used for importing bitmaps of various formats, including animations.
*
*	It is the base class for all the importers. It defines the has a static Book
*	pointer class that is a map for the importers factory creators and the strings
*	of the extension that the importer can understand. It allows to create the a
*	pointer to a particular importer just by using the extension of the name of file
*	to import. Also it creates a virtual member get_frame that must be declared in
*	the inherited classes.
*	\see module.h
**	\
*/
class Importer : public etl::shared_object
{
public:
    // Type that represents a pointer to a Importer's constructor.
    // As a pointer to the constructor, it represents a "factory" of importers.
    typedef Importer* (*Factory)(const FileSystem::Identifier &identifier);

    struct BookEntry {
        Factory factory;
        bool supports_file_system_wrapper;

        BookEntry(): factory(NULL), supports_file_system_wrapper(false) { }
        BookEntry(Factory factory, bool supports_file_system_wrapper):
            factory(factory), supports_file_system_wrapper(supports_file_system_wrapper)
        { }
    };

    typedef std::map<std::string, BookEntry> Book;
    static Book* book_;

    static Book& book();

    // Initializes the Import module by creating a book of importers names
    // and its creators and the list of open importers
    static bool subsys_init();
    // Stops the Import module by deleting the book and the list of open
    // importers
    static bool subsys_stop();

    typedef etl::handle<Importer> Handle;
    typedef etl::loose_handle<Importer> LooseHandle;
    typedef etl::handle<const Importer> ConstHandle;

private:
    // Gamma of the importer.
    // TODO:  Do not hardcode the gamma to 2.2
    Gamma gamma_;
    rendering::Surface::Handle last_surface_;

protected:

    Importer(const FileSystem::Identifier &identifier);

public:
    const FileSystem::Identifier identifier;

    Gamma& gamma()
    {
        return gamma_;
    }
    const Gamma& gamma()const
    {
        return gamma_;
    }

    virtual ~Importer();

    // Gets a frame and puts it into \a surface
    /*!	\param	surface Reference to surface to put frame into
    **	\param	time	For animated importers, determines which frame to get.
    **		For static importers, this parameter is unused.
    **	\param	callback Pointer to callback class for progress, errors, etc.
    **	\return \c true on success, \c false on error
    **	\see ProgressCallback, Surface
    */
    virtual bool get_frame(Surface &surface, const RendDesc &renddesc, Time time, ProgressCallback *callback = NULL) = 0;
    virtual bool get_frame(Surface &surface, const RendDesc &renddesc, Time time,
                           bool &trimmed __attribute__((unused)),
                           unsigned int &width __attribute__((unused)),
                           unsigned int &height __attribute__((unused)),
                           unsigned int &top __attribute__((unused)),
                           unsigned int &left __attribute__((unused)),
                           ProgressCallback *callback = NULL)
    {
        return get_frame(surface, renddesc, time, callback);
    }

    virtual rendering::Surface::Handle get_frame(const RendDesc &renddesc, const Time &time);

    // Returns \c true if the importer pays attention to the \a time parameter of get_frame()
    virtual bool is_animated()
    {
        return false;
    }

    // Attempts to open \a filename, and returns a handle to the associated Importer
    static Handle open(const FileSystem::Identifier &identifier);
};

}; // END of namespace synfig

#endif